通过创建一个用户对象,让 Ping++ 连通你的系统中的用户。可以通过用户对象管理个人信息,查看余额、优惠券等相关信息。 在每个应用创建时,我们会为其分配一个初始用户,id 为 “0”,表示该应用的系统用户,除此之外,所有用户都由你传入的用户 id 创建。 用户分为 customer 类型和 business 类型,customer 类型可以通过用户对象创建接口创建,也可以在使用其他带有用户 id 字段的模块相关接口(如充值、优惠券)时由 Ping++ 自动创建并初始化; business 类型目前只能通过创建子商户时创建,详情请参考 商户层级。
如果你需要使用订单、余额、优惠券、商户层级、分润等模块的相关功能时,你需要了解并使用用户的相关接口。
| 属性 | 描述 |
|---|---|
| id string | 用户 ID ,64 位以内,首字母必须是英文、数字或者下划线。 |
| object string | 值为 "user"。 |
| app string | 对应 app 对象的 id,查看 如何获取App ID。 |
| type string | 用户类型,取值范围:customer 为个人用户,business 为企业用户。 |
| related_app string | 当 type 值为 business 时,该用户关联的 Ping++ 的 app 对象 id |
| address string | 用户地址。 |
| available_coupons int | 可用优惠券数量。 |
| avatar string | 头像图片地址。 |
| available_balance int | 可用余额,可用于消费。 |
| withdrawable_balance int | 可提现余额,可用于消费、提现、转账等。 |
| created int | 创建时间,使用 unix 时间戳表示。 |
| disabled boolean | 是否被禁用。禁用后,相关用户的功能均不可使用。 |
| email string | 邮箱地址。 |
| gender string | 性别。MALE:男;FEMALE:女,为空时表示未填写。 |
| identified boolean | 是否经过实名认证。 |
| livemode boolean | 是否处于 live 模式。 |
| mobile string | 手机号码。 |
| name string | 用户昵称。 |
| metadata hash | 详见 元数据。 |
| settle_accounts hash | 用户结算账户列表,请参考 用户结算账户对象。 |
| parent_user_id string | 父级用户 ID。长度:64 位以内,首字母必须是英文、数字或者下划线。 |
{
"id": "test_user_003",
"object": "user",
"app": "app_1Gqj58ynP0mHeX1q",
"address": null,
"available_coupons": 0,
"avatar": null,
"available_balance": 0,
"withdrawable_balance": 0,
"created": 1470215837,
"disabled": false,
"email": null,
"gender": "MALE",
"identified": false,
"livemode": true,
"metadata": {},
"mobile": null,
"name": "name003",
"type": "customer",
"related_app": null,
"settle_accounts": []
}